probe_data Class Reference

Data structure to hold & output probe data probe data is designed to be used to return the number of objects in a given area or areas in specific element or vegetation types or farms. More...

#include <PopulationManager.h>

Public Member Functions
void	FileOutput (int No, int time, int ProbeNo)
void	FileAppendOutput (int No, int time)
	probe_data ()
void	SetFile (ofstream *F)
ofstream *	OpenFile (char *Nme)
bool	OpenForAppendToFile ()
void	CloseFile ()
	~probe_data ()

Public Attributes
bool	m_FileRecord
unsigned	m_ReportInterval
unsigned	m_NoAreas
rectangle	m_Rect [10]
unsigned	m_NoEleTypes
unsigned	m_NoVegTypes
unsigned	m_NoFarms
TTypesOfVegetation	m_RefVeg [25]
TTypesOfLandscapeElement	m_RefEle [25]
unsigned	m_RefFarms [25]
bool	m_TargetTypes [10]

Protected Attributes
ofstream *	m_MyFile
int	m_Time
char	m_MyFileName [255]

Detailed Description

Data structure to hold & output probe data probe data is designed to be used to return the number of objects in a given area or areas in specific element or vegetation types or farms.

Constructor & Destructor Documentation

probe_data()

probe_data::probe_data

(

)

Constructor for probe_data

                       {
  m_Time = 0;
  m_FileRecord = false;
  m_MyFile = NULL;
}

~probe_data()

probe_data::~probe_data

(

)

Destructor for probe_data

                        {
}

Member Function Documentation

CloseFile()

void probe_data::CloseFile

(

)

                           {
  if ( m_MyFile != NULL ) {
      if (m_MyFile->is_open()) m_MyFile->close();
      delete m_MyFile;
  }
};

Referenced by CloseDownSim().

FileAppendOutput()

void probe_data::FileAppendOutput	(	int	No,
		int	time
	)

                                                    {
  m_MyFile->open(m_MyFileName,ios::app);
  if ( !m_MyFile->is_open() ) {
    g_msg->Warn( (MapErrorState)0,"Cannot open file for append: ", m_MyFileName );
    exit( 0 );
  }
  if ( m_FileRecord ) {
   (*m_MyFile)<< time << '\t' << No << endl;
  }
  m_MyFile->close();
}

References g_msg, and MapErrorMsg::Warn().

FileOutput()

void probe_data::FileOutput	(	int	No,
		int	time,
		int	ProbeNo
	)

Basic output function of the default probe data file.
This just counts numbers in specified areas

                                                           {
  if ( m_FileRecord ) {
 
    if ( ProbeNo == 0 ) {
      // First probe so write the time and a new line
      (*m_MyFile) << endl;
      (*m_MyFile) << time << '\t' << No;
    } else
      (*m_MyFile) << '\t' << No ;
  }
  (*m_MyFile).flush();
}

Referenced by Skylark_Population_Manager::ProbeReportPOM().

OpenFile()

ofstream * probe_data::OpenFile

(

char *

Nme

)

Opens the default probe data output file

                                            {
  m_MyFile = new ofstream( Nme );
  if ( !m_MyFile->is_open() ) {
    g_msg->Warn( (MapErrorState)0,"probe_data::OpenFile - Cannot open file: ", Nme );
    exit( 0 );
  }
  strcpy( m_MyFileName, Nme );
  return m_MyFile;
}

References g_msg, and MapErrorMsg::Warn().

Referenced by GetProbeInput_ini().

OpenForAppendToFile()

bool probe_data::OpenForAppendToFile ( )

inline

                             {
      m_MyFile = new ofstream(m_MyFileName, ios::app);
      if (!(*m_MyFile).is_open())
      {
          g_msg->Warn( WARN_FILE, "PopulationManager::AppendToFile() Unable to open file for append: ", m_MyFileName );
          exit(1);
      }
      return true;
  }

References g_msg, m_MyFile, m_MyFileName, MapErrorMsg::Warn(), and WARN_FILE.

SetFile()

void probe_data::SetFile

(

ofstream *

F

)

Sets the filename for the default probe data output

                                       {
  m_MyFile = F;
}

Referenced by GetProbeInput_ini().

Member Data Documentation

m_FileRecord

bool probe_data::m_FileRecord

m_MyFile

ofstream* probe_data::m_MyFile

protected

Referenced by OpenForAppendToFile().

m_MyFileName

char probe_data::m_MyFileName[255]

protected

Referenced by OpenForAppendToFile().

m_NoAreas

unsigned probe_data::m_NoAreas

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), and TSkylarkList< T >::Probe().

m_NoEleTypes

unsigned probe_data::m_NoEleTypes

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), and TSkylarkList< T >::Probe().

m_NoFarms

unsigned probe_data::m_NoFarms

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), TSkylarkList< T >::Probe(), and Skylark_Population_Manager::ProbePOM().

m_NoVegTypes

unsigned probe_data::m_NoVegTypes

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), and TSkylarkList< T >::Probe().

m_Rect

rectangle probe_data::m_Rect[10]

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), and TSkylarkList< T >::Probe().

m_RefEle

TTypesOfLandscapeElement probe_data::m_RefEle[25]

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), and TSkylarkList< T >::Probe().

m_RefFarms

unsigned probe_data::m_RefFarms[25]

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), TSkylarkList< T >::Probe(), and Skylark_Population_Manager::ProbePOM().

m_RefVeg

TTypesOfVegetation probe_data::m_RefVeg[25]

Referenced by Population_Manager::Probe(), Bembidion_Population_Manager::Probe(), and TSkylarkList< T >::Probe().

m_ReportInterval

unsigned probe_data::m_ReportInterval

m_TargetTypes

bool probe_data::m_TargetTypes[10]

m_Time

int probe_data::m_Time

protected

---

The documentation for this class was generated from the following files:

• /builds/a1mass/almass_stable_oddox/BatchALMaSS/PopulationManager.h
• /builds/a1mass/almass_stable_oddox/BatchALMaSS/PopulationManager.cpp